跳到主要内容
版本:V4.0

项目管理API


获取项目信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObjectBody命令参数

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObject<result>Body返回结果

result说明

参数名类型位置说明
project_idStringBody项目ID
project_nameStringBody项目名称
currencyStringBody货币
visit_urlStringBody访问地址
addressObject<address>Body地址
roomObject<room>Body房间信息
deviceObject<device>Body设备信息

address说明

参数名类型位置说明
countryStringBody国家
state_provinceStringBody州/省份
cityStringBody城市
streetStringBody街道
postcodeStringBody邮编

room说明

参数名类型位置说明
to_stayIntegerBody待入住
checked_outIntegerBody已退房
dirtyIntegerBody脏房间
vacant_dirtyIntegerBody空脏房间
occupied_dirtyIntegerBody住客脏房间
vacant_cleanIntegerBody空干净房间
occupied_cleanIntegerBody住客干净房间
dndIntegerBody勿扰房间
vacant_todayIntegerBody今日空房
checked_in_todayIntegerBody今日入住
number_of_staying_todayIntegerBody今日入住人数
occupancy_rate_todayIntegerBody今日入住率

device说明

参数名类型位置说明
totalIntegerBody总数
onlineIntegerBody在线
offlineIntegerBody离线
low_powerIntegerBody低电量

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_project_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
"project_name": "test",
"currency": "USD:US Dollar",
"visit_url": "https://test.akubela.com/g",
"address": {
"country": "Austria",
"state_province": "Tirol",
"city": "Absam",
"street": "test",
"postcode": "0000001"
},
"room": {
"to_stay": 0,
"checked_out": 0,
"dirty": 0,
"vacant_dirty": 0,
"occupied_dirty": 0,
"vacant_clean": 0,
"occupied_clean": 0,
"dnd": 0,
"vacant_today": 0,
"checked_in_today": 0,
"number_of_staying_today": 0,
"occupancy_rate_today": 0
},
"device": {
"total": 0,
"online": 0,
"offline": 0,
"low_power": 0
}
}
}

失败返回示例

接口失败返回



更新项目信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
currencyStringBody货币

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "update_project_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"currency": "USD:US Dollar"
}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

失败返回示例

接口失败返回



获取货币列表

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObjectBody命令参数

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
result[]Object<result>Body返回结果

result说明

参数名类型位置说明
currencyStringBody货币

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_currency_list",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": [
{
"currency": "USD:US Dollar"
}
]
}

失败返回示例

接口失败返回